home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 October / Macworld (1998-10).dmg / Shareware World / Utilities / Text Processing / GST-TGhostDemo / Torquemada’s Ghost Glue / DocServer Source Text / TQMGhost DocServer Text < prev   
Text File  |  1998-08-01  |  5KB  |  102 lines
  1.  
  2. Verb    TQMGhost.batchProcess
  3. Syntax    TQMGhost.batchProcess ()
  4. Parameters    None.
  5. Action    Runs a dialog-driven suite that allows the user to batch process with Torquemada’s Ghost by selecting folders of files.
  6. Also includes a preferences dialog and utilities to change type and creator of files between TQM types and the user’s word processor.
  7. Designed for Frontier Runtime users who cannot write or do not intend to write scripts.
  8. Returns    True if run successfully, false if error or canceled by user.
  9. Examples    See the read-me file that accompanies the installer for full instructions.
  10. Notes    Requires Torquemada’s Ghost 1.3.0 by Greg Swann.
  11. See Also    TQMGhost.sendFile
  12.  
  13. Verb    TQMGhost.isRunning
  14. Syntax    TQMGhost.isRunning ()
  15. Parameters    None.
  16. Action    Checks to see if Torquemada’s Ghost is currently running.
  17. Returns    True if running, false if not.
  18. See Also    TQMGhost.bringToFront
  19. TQMGhost.launch
  20. TQMGhost.quit
  21.  
  22. Verb    TQMGhost.launch
  23. Syntax    TQMGhost.launch ()
  24. Parameters    None.
  25. Action    Launches Torquemada’s Ghost, if not already running.
  26. Returns    True if successful, false if not.
  27. Notes    Not required for TQMGhost.sendFile.
  28. Requires Torquemada’s Ghost 1.3.0 by Greg Swann.
  29. See Also    TQMGhost.bringToFront
  30. TQMGhost.isRunning
  31. TQMGhost.quit
  32.  
  33. Verb    TQMGhost.makeTQMcontrol
  34. Syntax    TQMGhost.makeTQMcontrol (path)
  35. Parameters    path = full path to the desired file (stringType).
  36. Action    Changes type and creator of file in path to a Torquemada’s Ghost control file.
  37. Returns    True if successful, false if not.
  38. Example    TQMGhost.makeTQMcontrol ("My Hard Drive:Text Files:Control file")
  39. Notes    This verb works quietly in the background with no user interface.
  40. The file must conform to Torquemada’s Ghost control file specs, or it will not function properly.
  41. See Also    TQMGhost.makeTQMset
  42. TQMGhost.makeWPfile
  43.  
  44. Verb    TQMGhost.makeTQMset
  45. Syntax    TQMGhost.makeTQMset (path)
  46. Parameters    path = full path to the desired file (stringType)
  47. Action    Changes the type and creator of the file specified in path to a TQM set file.
  48. Returns    True if successful, false if not.
  49. Example    TQMGhost.makeTQMset ("My Hard Drive:TQM set files:Killer set")
  50. Notes    This version works silently in the background with no user interface.
  51. TQM sets can be used with both Torquemada’s Ghost and the most recent version of Torquemada the Inquisitor.
  52. The file must conform to TQM specs or it will not function properly.
  53. See Also    TQMGhost.makeWPfile
  54. TQMGhost.makeControlfile
  55.  
  56. Verb    TQMGhost.makeWPfile
  57. Syntax    TQMGhost.makeWPfile (path)
  58. Parameters    path = full path to the desired file (stringType)
  59. Action    Changes the type of file in path to a text file. Creator is changed to creator specified in TQMGhost.prefs.Creator.
  60. Returns    True if successful, false if not.
  61. Example    TQMGhost.makeWPfile ("My Hard Drive:Text Files:Cool text")
  62. Notes    This version works silently in the background with no user interface.
  63. The contents of TQMGhost.prefs.Contents must be a string4 matching the creator signature of the desired word processor.
  64. See Also    TQMGhost.makeControlfile
  65. TQMGhost.makeTQMset
  66.  
  67. Verb    TQMGhost.quit
  68. Syntax    TQMGhost.quit ()
  69. Parameters    None.
  70. Action    Quits Torquemada’s Ghost if running.
  71. Returns    True.
  72. Notes    Using this verb when Torquemada’s Ghost is not running has no effect.
  73. Requires Torquemada’s Ghost 1.3.0 by Greg Swann.
  74. See Also    TQMGhost.isRunning
  75. TQMGhost.launch
  76.  
  77. Verb    TQMGhost.sendFile
  78. Syntax    TQMGhost.sendFile (path)
  79. Parameters    path = full path to the desired file (stringType)
  80. Action    Opens the specified file in Torquemada’s Ghost.
  81. Launches Torquemada’s Ghost if not running.
  82. Torquemada’s Ghost will remain waiting for further files until a control file is opened or the Start button is clicked.
  83. Returns    True.
  84. Example    TQMGhost.sendFile ("My Hard Drive:Text Files:Cool Text")
  85. Notes    See the documentation for Torquemada’s Ghost for an explanation of how files sent with AppleEvents control the app.
  86. Requires Torquemada’s Ghost 1.3.0 by Greg Swann.
  87. See Also    TQMGhost.batchProcess
  88.  
  89. Verb    TQMGhost.startTQM
  90. Syntax    TQMGhost.startTQM (controlFile, destination)
  91. Parameters    controlFile = full path (including name) of the control file to be created (stringType).
  92. destination = full path to an existing folder where processed files are to be saved (stringType).
  93. Action    Creates a control file containing destination path.
  94. Launches Torquemada’s Ghost if not running.
  95. Starts TQMGhost processing.
  96. Returns    True.
  97. Example    TQMGhost.startTQM ("My Hard Drive:System Folder:TQM Control file", "My Hard Drive: Finished text:")
  98. Notes    See the documentation for Torquemada’s Ghost for an explanation of how files sent with AppleEvents control the app.
  99. Requires Torquemada’s Ghost 1.3.0 by Greg Swann.
  100. See Also    TQMGhost.batchProcess
  101. TQMGhost.makeTQMcontrol
  102.